<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class SensapilityChannel</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class SensapilityChannel</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">version:</span> 0.1</li>
				<li><span class="field">author:</span> api.jmatt@gmail.com</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_sensapilitychannel.php.html">/sensapilitychannel.php</a> (line <span class="field">27</span>)
		</p>
		
				
		<pre><a href="../default/SensapilityService.html">SensapilityService</a>
   |
   --SensapilityChannel</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																				
												<div class="method-definition">
											<span class="method-result">none</span>
										<a href="#SensapilityChannel" title="details" class="method-name">SensapilityChannel</a>
											(<span class="var-type">soapclientnusoap</span>&nbsp;<span class="var-name">$soapClient</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$namespaces</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$defaultNamespaceLabel</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">Channel_Data</span>
										<a href="#createChannel" title="details" class="method-name">createChannel</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$serviceId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$urlOrCustom</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#createChannels" title="details" class="method-name">createChannels</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelArray</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">none</span>
										<a href="#deleteChannel" title="details" class="method-name">deleteChannel</a>
											(<span class="var-type">long</span>&nbsp;<span class="var-name">$killTarget</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">none</span>
										<a href="#deleteChannels" title="details" class="method-name">deleteChannels</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$killTargets</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">Channel_Data</span>
										<a href="#getChannel" title="details" class="method-name">getChannel</a>
											(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getChannels" title="details" class="method-name">getChannels</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelIds</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">SyndicationService_Data</span>
										<a href="#getSyndicationService" title="details" class="method-name">getSyndicationService</a>
											(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">none</span>
										<a href="#updateChannel" title="details" class="method-name">updateChannel</a>
											(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$synServiceId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">none</span>
										<a href="#updateChannels" title="details" class="method-name">updateChannels</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelArray</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodSensapilityChannel" id="SensapilityChannel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor SensapilityChannel</span> (line <span class="line-number">38</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">none</span>
		<span class="method-name">
			SensapilityChannel
		</span>
					(<span class="var-type">soapclientnusoap</span>&nbsp;<span class="var-name">$soapClient</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$namespaces</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$defaultNamespaceLabel</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">soapclientnusoap</span>
				<span class="var-name">$soapClient</span><span class="var-description">: the NuSOAP object that communicates  with the service</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$namespaces</span><span class="var-description">: associative array that matches namespace labels  to namespace URIs</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$defaultNamespaceLabel</span><span class="var-description">: the namespace to be used with most  tags</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateChannel" id="createChannel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">createChannel</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a new URL or custom channel.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A Channel_Data object with the channel id set</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Channel_Data</span>
		<span class="method-name">
			createChannel
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$serviceId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$urlOrCustom</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: For a custom channel, the name of that channel, for  a URL channel, the URL that corresponds to that channel</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$status</span><span class="var-description">: Either 'Active' or 'Inactive'</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$serviceId</span><span class="var-description">: The syndication service id that this channel will  be assigned to</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$urlOrCustom</span><span class="var-description">: What type of channel this is, either 'Url' or  'Custom'</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateChannels" id="createChannels"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">createChannels</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create multiple channels in one request</p>
	<ul class="tags">
				<li><span class="field">return:</span> An array of Channel_Data objects</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			createChannels
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelArray</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$channelArray</span><span class="var-description">: An associative array formatted like a  Channel_Data object</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddeleteChannel" id="deleteChannel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">deleteChannel</span> (line <span class="line-number">112</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the specified channel</p>
	
	<div class="method-signature">
		<span class="method-result">none</span>
		<span class="method-name">
			deleteChannel
		</span>
					(<span class="var-type">long</span>&nbsp;<span class="var-name">$killTarget</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">long</span>
				<span class="var-name">$killTarget</span><span class="var-description">: The id of the channel to be removed.</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddeleteChannels" id="deleteChannels"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">deleteChannels</span> (line <span class="line-number">131</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes specified channels</p>
	
	<div class="method-signature">
		<span class="method-result">none</span>
		<span class="method-name">
			deleteChannels
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$killTargets</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$killTargets</span><span class="var-description">: an array of longs which are channel ids to  remove</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetChannel" id="getChannel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getChannel</span> (line <span class="line-number">155</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves information for specified channel</p>
	<ul class="tags">
				<li><span class="field">return:</span> a Channel_Data object that represents the requested  channel</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Channel_Data</span>
		<span class="method-name">
			getChannel
		</span>
					(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">long</span>
				<span class="var-name">$channelId</span><span class="var-description">: The numeric identifier for this channel</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetChannels" id="getChannels"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getChannels</span> (line <span class="line-number">173</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves information for specified channels</p>
	<ul class="tags">
				<li><span class="field">return:</span> Array of Channel_Data objects for the channels requested</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getChannels
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelIds</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$channelIds</span><span class="var-description">: Array of numeric identifiers for channels</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSyndicationService" id="getSyndicationService"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSyndicationService</span> (line <span class="line-number">197</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the service a given channel belongs to</p>
	<ul class="tags">
				<li><span class="field">return:</span> A SyndicationService_Data object for the  service that this channel belongs to.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">SyndicationService_Data</span>
		<span class="method-name">
			getSyndicationService
		</span>
					(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">long</span>
				<span class="var-name">$channelId</span><span class="var-description">: The numeric ID of the channel in question</span>			</li>
				</ul>
		
			
	</div>
<a name="methodupdateChannel" id="updateChannel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">updateChannel</span> (line <span class="line-number">222</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Update attributes of a channel</p>
	
	<div class="method-signature">
		<span class="method-result">none</span>
		<span class="method-name">
			updateChannel
		</span>
					(<span class="var-type">long</span>&nbsp;<span class="var-name">$channelId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$synServiceId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">long</span>
				<span class="var-name">$channelId</span><span class="var-description">: The channel to update</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The name of the channel, for Url channels, this is  the URL of the page corresponding to the channel</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$status</span><span class="var-description">: 'Active' or 'Inactive'</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$synServiceId</span><span class="var-description">: The service id for the account this channel  belongs to</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span><span class="var-description">: The type of channel this is, note this can never be  updated</span>			</li>
				</ul>
		
			
	</div>
<a name="methodupdateChannels" id="updateChannels"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">updateChannels</span> (line <span class="line-number">246</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The same as update channel, but updates multiple channels in a single call</p>
	
	<div class="method-signature">
		<span class="method-result">none</span>
		<span class="method-name">
			updateChannels
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$channelArray</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$channelArray</span><span class="var-description">: Array of Channel_Data objects with the  update information</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../default/SensapilityService.html">SensapilityService</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../default/SensapilityService.html#methodSensapilityService">SensapilityService::SensapilityService()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodcheckForFailure">SensapilityService::checkForFailure()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodcomputeDepth">SensapilityService::computeDepth()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methoddeepenArray">SensapilityService::deepenArray()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methoddoSoapCall">SensapilityService::doSoapCall()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodformatError">SensapilityService::formatError()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodformatFault">SensapilityService::formatFault()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodgetHeaders">SensapilityService::getHeaders()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodgetLastCallError">SensapilityService::getLastCallError()</a></span><br>
													<span class="method-name"><a href="../default/SensapilityService.html#methodsetHeaders">SensapilityService::setHeaders()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 25 May 2007 13:35:28 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.1</a>
	</p>
	</div></body>
</html>